home *** CD-ROM | disk | FTP | other *** search
/ Deutsche Edition 1 / Deutsche Edition 1.iso / time / time_61-70 / time_64 / multiplayerv1_30 / multiplayerv1_30.lha / Player.doc < prev    next >
Text File  |  1992-05-25  |  68KB  |  1,556 lines

  1.                                 MultiPlayer
  2.                                Version 1.30
  3.                        Copyright (C) 1992 Bryan Ford
  4.  
  5.  
  6.  
  7.                             License/Disclaimer
  8.                             ~~~~~~~~~~~~~~~~~~
  9.  
  10.     This program is free software; you can redistribute it and/or modify it
  11. under the terms of the GNU General Public License as published by the Free
  12. Software Foundation; either version 2 of the License, or (at your option)
  13. any later version.
  14.  
  15.     This program is distributed in the hope that it will be useful, but
  16. WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  17. or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  18. for more details.
  19.  
  20.     You should have received a copy of the GNU General Public License along
  21. with this program; if not, write to the Free Software Foundation, Inc.,
  22. 675 Mass Ave, Cambridge, MA 02139, USA.
  23.  
  24.  
  25.  
  26.                                Introduction
  27.                                ~~~~~~~~~~~~
  28.  
  29.     Welcome to the most powerful, versatile, and user-friendly music player
  30. ever created on the Amiga!  As you will see, MultiPlayer has almost all the
  31. features you've seen in other music players, plus a great number that have
  32. never been implemented before in a music player.
  33.  
  34.     If you want to get full benefit from MultiPlayer you should at least
  35. scan through this whole documentation.  However, it is very easy to use, so
  36. feel free to take it for a test drive first.  If you're upgrading from a
  37. previous version of MultiPlayer, make sure you look at the History section
  38. near the end of this document to see what's new.
  39.  
  40.     One of the goals of MultiPlayer is to be as system-friendly as
  41. possible.  It multitasks well, it doesn't interfere with high-priority
  42. interrupts such as serial port interrupts, and it properly allocates audio
  43. channels so that the music doesn't conflict with other programs.  It takes
  44. full advantage of (and requires) Kickstart 2.0, and it isn't prone to
  45. "lose" notes on fast processors like most other players are.
  46.  
  47.     Another goal of MultiPlayer is to support a very diverse array of music
  48. formats.  MultiPlayer currently supports over twenty different common
  49. module formats, plus some special ones.  See 'Supported Formats' near the
  50. end of this document for a list of the module types MultiPlayer can play.
  51. (Not all of MultiPlayer's features are available with every module format,
  52. but MultiPlayer will at least play each format on the list.)
  53.  
  54.  
  55.  
  56.                          Updates and Registration
  57.                          ~~~~~~~~~~~~~~~~~~~~~~~~
  58.  
  59.     As of version 1.30, MultiPlayer is no longer Shareware: it is free
  60. software, distributed under the GNU General Public License.  See the file
  61. COPYING-2 for details.  However, this does not mean that previous
  62. registered users lose the benefits they paid for, nor does it mean that I
  63. no longer want people to register MultiPlayer.  (Although I realize that,
  64. in practice, I will probably not receive as many registrations as when it
  65. was "crippleware.")
  66.  
  67.     So here's how things work now.  Unregistered users may, at any time,
  68. obtain the latest "official" version of MultiPlayer by sending $5 (U.S.
  69. currency) to my address listed at the end of this document.  I will send
  70. you the latest version, including full source code, on two disks.  If you
  71. would like the RCS source code files (containing revision differences and
  72. such) instead of the immediately-compilable source code, just say so.
  73.  
  74.     For a one-time registration fee of $15 (the same as when MultiPlayer
  75. was Shareware), you get several important advantages.  First, you get on my
  76. permanent mailing list, so you will hear about major new updates to
  77. MultiPlayer and other pertinent news.  Second, you can get the latest
  78. version of MultiPlayer (with full source code of course) by sending me
  79. either $2, OR a self-addressed, stamped mailer containing two blank disks.
  80. (If you want the RCS files, remember to say so.)
  81.  
  82.     Registered users may also request updates in advance.  Simply send in
  83. the $2 or mailer with disks in advance, tell me what the latest version you
  84. already have is, and I'll mail the update as soon as the next version comes
  85. out.  Again, this service is only available to registered users.
  86.  
  87.     Finally, registered users gain an "inner ear":  Though I can never
  88. promise that I can implement some desired feature or another, I will at
  89. least make an attempt to implement features requested by registered users
  90. before doing other things.  I will NOT go out of my way to satisfy the
  91. wishes of unregistered users: $15 is nothing compared to the registration
  92. fees of many smaller Shareware programs of much lower quality.
  93.  
  94.     In any case, I will continue to maintain the "official" MultiPlayer
  95. distribution, merging bug fixes and enhancements done by other people into
  96. it.  Of course, under the General Public License anyone is free to
  97. distribute their own modified versions, and I will not try to restrict
  98. distribution of MultiPlayer.  However, maintaining a central,
  99. easily-available distribution set has some obvious important advantages.
  100.  
  101.     If you have a bug fix or enhancement you'd like included in the
  102. official distribution, send it to me and I'll probably (no promises)
  103. incorporate it IF it's reasonably clean, isn't likely to break lots of
  104. other things, seems at least slightly useful, is understandable to me, etc.
  105. If your added or modified code is more than about a screen or so long, I'll
  106. need a signed (paper) document releasing all rights to the code to me, for
  107. distribution under the General Public License.  (I hate legal details, but
  108. I hate even more getting into stupid squabbles and/or lawsuits due to an
  109. oversight of legal details.)  If your additions are quite extensive (i.e. a
  110. new module or something like that) and you work for a computer-related
  111. company of some kind, I may get nervous and require a signed disclaimer
  112. from your employer as well.
  113.  
  114.  
  115.  
  116.                               Acknowledgments
  117.                               ~~~~~~~~~~~~~~~
  118.  
  119.         Michael Sinz (CBM) for tips on the memory manager.
  120.  
  121.         Darren Schebek for lots of suggestions and ideas.
  122.  
  123.         Janne Saarme for lots of players and other stuff.
  124.  
  125.         Teijo Kinnunen for MED/OctaMED support and player code.
  126.  
  127.         Barry McConnell for lots of testing and suggestions.
  128.  
  129.         Maruku Burano for the module scrolltext idea (and some great
  130.             modules of course :-) )
  131.  
  132.         And most of all, to the talented people who create all the
  133.             wonderful music on the Amiga!
  134.  
  135.  
  136.  
  137.                                General Usage
  138.                                ~~~~~~~~~~~~~
  139.  
  140.     To start MultiPlayer, just type 'player' from the CLI or click on the
  141. icon from the Workbench and it will present the ASL filerequester to select
  142. a module from.  Note that you can select multiple modules at a time (as
  143. many as you want).  If you run MultiPlayer from the CLI, it automatically
  144. detaches itself, so there is no need to Run it.  (You can turn this feature
  145. off, however.)  You can also start modules playing immediately when
  146. MultiPlayer starts up.  See the section on 'Startup Options' for more
  147. information on starting MultiPlayer.
  148.  
  149.     While MultiPlayer is running there is normally a small window in the
  150. title bar displaying the name of the module that is currently playing (or
  151. just "MultiPlayer" if nothing is loaded).  You can click the close gadget
  152. to stop the music and terminate MultiPlayer.  (You can change this behavior
  153. in the Preferences window so that closing the main window simply hides the
  154. user interface, leaving MultiPlayer active in the background.)  The main
  155. MultiPlayer window has a zoom gadget near its right end.  If you click it,
  156. you will see a control panel that allows you to load different modules and
  157. gives access to some of MultiPlayer's more advanced features.
  158.  
  159.     If you have the xpkmaster.library (a freeware compression "supervisor"
  160. standard mostly by Dominik Mueller, Christian Schneider, and myself)
  161. installed in your system, MultiPlayer can automatically unpack modules that
  162. are packed using any format it can understand.  (This includes PowerPacker
  163. format, if you have the powerpacker.library installed as well.)
  164.  
  165.     If you start getting shaky when you see MultiPlayer's size (>90K),
  166. don't worry - thanks to a custom memory management and overlay system
  167. called Bovs, MultiPlayer uses only the memory it needs to do its job.  All
  168. of the module players are loaded only when needed, and any players not
  169. currently in use are unloaded on demand if the system runs out of memory.
  170. The parts of the program used to control MultiPlayer's various windows are
  171. also only loaded when they are needed (when the respective windows are
  172. open) and are freed as necessary.  Thus, generally only a small fraction of
  173. the program code is loaded at any one time.
  174.  
  175.     If you have tons of memory and don't want overlays, the registered
  176. release comes with a separate version of MultiPlayer ("Player.nov") that
  177. runs without overlays (like a normal program).  It generally uses about 50K
  178. more memory than the overlaid version does, but it can be compressed with
  179. PowerPacker or Imploder if you're short on disk space.  (Imploder *should*
  180. be able to compress the overlaid version of MultiPlayer, but it won't - I
  181. haven't figured out why.)
  182.  
  183.     For all you hackers (used in the positive meaning) that like to rip out
  184. every form of music imaginable, when you come across some obscure module
  185. format that nothing understands, don't despair.  There are several special
  186. formats built into MultiPlayer that you can use to easily interface it to
  187. any kind of module.  All you need is the module, some player code for the
  188. module (if the module doesn't already have embedded player code), and a
  189. little assembly language coding.  Details on all three formats are in the
  190. separate file 'GMOD.doc' (in the Programmers directory of the official
  191. MultiPlayer distribution).  If you are the author of a music composer
  192. program, you should also read this document and consider supporting the
  193. GMOD embedded-player module format in your program.  (It's not a music
  194. storage standard - it's more like a music playing standard - see the
  195. document for details.)
  196.  
  197.  
  198.  
  199.                                Control Panel
  200.                                ~~~~~~~~~~~~~
  201.  
  202.     The main MultiPlayer window normally sits quietly in the title bar. (If
  203. you don't like it there, move it somewhere else and save the preferences -
  204. it'll stay put wherever you want it.)  However, if you click the zoom
  205. gadget, it will become a control panel.  The F1 key also performs this
  206. function. If you have a 3-button mouse, the middle button will act the same
  207. as the zoom gadget.  This panel displays a few pieces of information about
  208. the module currently playing, and has some buttons you can use to control
  209. MultiPlayer.
  210.  
  211.     The MultiPlayer control panel is an AppWindow, so you can play modules
  212. by simply dropping their Workbench icons into the MultiPlayer window.  When
  213. you do, the new module (or several modules, if you extended-select them)
  214. replaces the current program, and MultiPlayer starts playing the first
  215. module immediately.  This works basically like selecting modules with the
  216. New button.
  217.  
  218.  
  219. Module box
  220.  
  221.     This box displays the filename of the module currently loaded
  222. (essentially the same as what is displayed in the title bar).  Any 'mod.'
  223. prefixes for Soundtracker/Noisetracker modules will not be displayed.
  224.  
  225.  
  226. Type box
  227.  
  228.     Displays the type of the loaded module (as MultiPlayer sees it).
  229. Simple enough?
  230.  
  231.  
  232. Author box
  233.  
  234.     Displays the name of the person who wrote this module, if MultiPlayer
  235. can glean this information from the module.  Most current module formats
  236. don't have direct facilities for identifying the author - in this case, the
  237. box will just display 'Unknown'.  Soundtracker/Noisetracker modules often
  238. have author names embedded in the instrument list - in this case,
  239. MultiPlayer will try to make a good guess by searching for keywords such as
  240. 'by'.  (If it screws up for some reason, you can always type the module in
  241. hex to find out for sure.)  MED modules have somewhat better support, but
  242. they still don't have a convenient 'author' field - just a catch-all
  243. 'annotation' field, which MultiPlayer processes much the same way as with
  244. Soundtracker modules.  GMOD modules are the only types I know of that
  245. directly support author identification, but they are at the moment few and
  246. far between.  (Let's get with it, OK?  Don't all the wonderful musicians
  247. want to be recognized?)
  248.  
  249.  
  250. Song gadget
  251.  
  252.     This gadget serves two purposes.  First, it displays the name of the
  253. currently loaded module or song as recorded in the module itself.  For
  254. example, with Soundtracker/Noisetracker modules this gadget will display
  255. the song name as recorded in the first 20 bytes of the file.  Many module
  256. formats don't have built-in name fields - in this case, the box will just
  257. display 'Unknown.'
  258.  
  259.     For most types of modules, which support only one song per module, this
  260. gadget will serve no purpose other than displaying the song name - clicking
  261. on it will do nothing.  However, some module formats (such as GMODs) allow
  262. several independent songs to be contained in a single module (for example,
  263. to save memory by using the same instruments on several songs).  In that
  264. case, this gadget will cycle through the available songs in the module.
  265. You can also change songs using the left and right arrow keys.
  266.  
  267.  
  268. Volume slider
  269.  
  270.     This slider controls the volume of the currently playing module.
  271. Minimum volume is all the way to the left; maximum is all the way to the
  272. right. This feature doesn't work with all types of modules, but it works
  273. with the most popular types.
  274.  
  275.     The current master volume, balance, and speed settings are saved with
  276. MultiPlayer's Preferences, so when MultiPlayer starts up they will be set
  277. to whatever they were set to last time you saved MultiPlayer's preferences.
  278.  
  279.  
  280. Balance slider
  281.  
  282.     This slider adjusts the balance by scaling the left and right volumes
  283. separately.  When the slider is all the way to the left, only the left
  284. channels will be played; when it is all the way to the right, only the
  285. right channels will be played.  Normally it's in the center, where both
  286. sides play with equal volume.  Like the volume control, this feature
  287. doesn't work with every type of module MultiPlayer supports.
  288.  
  289.  
  290. Balance Reset button ('=')
  291.  
  292.     The small button labeled with an equals sign resets (equalizes) the
  293. Balance slider, setting it back to the center position.
  294.  
  295.  
  296. Speed slider
  297.  
  298.     This slider can be used to fast-forward through a module.  The normal
  299. position is to the far left; moving the slider right will speed it up. This
  300. gadget isn't meant for controlling the module's normal playing speed - for
  301. that, use the speed control in the Settings window.
  302.  
  303.  
  304. Jump buttons ('<<' and '>>')
  305.  
  306.     For module types that support sequence jump, these buttons will
  307. instantly jump one sequence forward or backward in the module.
  308.  
  309.  
  310. New button
  311.  
  312.     This button displays the file requester and lets you select any number
  313. of modules.  The new list of modules replaces the current program, if there
  314. was one.  The first module in the list (or a random module, if you have
  315. selected random playing) will be started.  If you select a directory but
  316. don't select a file (leave the "File" string gadget blank), MultiPlayer
  317. scans the directory and adds everything in that directory to the program.
  318.  
  319.  
  320. Play button
  321.  
  322.     Starts or continues playing a module that was previously stopped but
  323. not unloaded.  If the module type supports the continue feature, the module
  324. will continue playing where it left off.  Otherwise it will start again
  325. from the beginning.  If you have selected the 'Fade...' checkbox in
  326. Preferences, and the module type supports volume control, the music will
  327. fade in gradually instead of just starting instantly.
  328.  
  329.  
  330. Stop button
  331.  
  332.     Stops the current module without unloading it.  Audio channels and
  333. interrupts are freed while a module is stopped, so you don't have to exit
  334. MultiPlayer completely if you want to run some other program that needs the
  335. audio hardware.  If you have selected the 'Fade...' checkbox in
  336. Preferences, and the module type supports volume control, the music will
  337. fade out gradually instead of stopping instantly.  If the module type
  338. supports restart, you can restart it where it left off by pressing the Play
  339. button.
  340.  
  341.  
  342. Eject button
  343.  
  344.     Stops and unloads the currently loaded module, and frees all memory and
  345. other resources that the module was using.
  346.  
  347.  
  348. Prev button
  349.  
  350.     Loads and plays the previous module in the program list.  If you have
  351. selected random play, this button simply loads another module in the list,
  352. at random.  This button does the same thing as pressing the up arrow key in
  353. the MultiPlayer window.
  354.  
  355.  
  356. Next button
  357.  
  358.     Loads and plays the next module in the current program list.  If you
  359. have selected random play, this button does basically the same thing as the
  360. Prev button - picks another module at random.  This is the same as pressing
  361. the down arrow key in the MultiPlayer window.
  362.  
  363.  
  364. Program, Prefs, Settings, and Info buttons
  365.  
  366.     These buttons toggle on or off some of MultiPlayer's other
  367. commonly-used windows.  They can also be controlled with the functions keys
  368. F2-F5 (respectively).
  369.  
  370.  
  371.  
  372.                               Program Window
  373.                               ~~~~~~~~~~~~~~
  374.  
  375.     The program window displays a list of all the modules in the current
  376. module 'program'. You can select modules from the list to load and play
  377. immediately by simply double-clicking on their names.  You can also build
  378. and rearrange your program using this window.  You get this window by
  379. pressing the 'Program' button on the main window's control panel, or by
  380. pressing the F2 keys in the MultiPlayer window, or by simply clicking the
  381. right mouse button while any of MultiPlayer's windows are active.  Note
  382. that this window doesn't cause the main control panel to "freeze" - you can
  383. still watch and use it while this window is open.  In fact, all of
  384. MultiPlayer's windows (even the file requester) work this way.  (I'm tired
  385. of Macinsquash-like modal requesters and such that only let you do one
  386. thing at a time.)
  387.  
  388.     Depending on the play mode selected in the Preferences window, when one
  389. module is finished, another module will be automatically loaded and played.
  390. (This only applies on modules that can detect repeat - most do, but on
  391. those that don't, unless you manually set an end time in the Settings
  392. window, the module will just play forever until you explicitly tell
  393. MultiPlayer to go to the next module.)  With random play, a different
  394. module will be randomly chosen.  There is no limit to the number of modules
  395. you can have in a program, and modules in the program can be located in
  396. many different directories - MultiPlayer will remember the location of each
  397. module.
  398.  
  399.     The Program window is an AppWindow, so you can add modules by simply
  400. dropping their icons into this window. This window works slightly
  401. differently from the main Multiplayer window, however.  When you drop icons
  402. into this window, the behavior is the same as if you had selected the
  403. modules with the 'Add' button:  The new modules are added to the end of the
  404. current program list (instead of replacing the current program), and
  405. whatever is currently playing remains unaffected.
  406.  
  407.     Besides the module listing, this window contains several buttons that
  408. allow you to manipulate the module list.  These are described below:
  409.  
  410.  
  411. Play button
  412.  
  413.     This button does basically the same thing as double-clicking on a
  414. module name in the program list.  It simply loads and starts playing the
  415. currently selected module.
  416.  
  417.  
  418. Current button
  419.  
  420.     Pressing this button will set the currently selected module to the
  421. currently playing module.
  422.  
  423.  
  424. Add button
  425.  
  426.     This button works much the same way as the 'New' button on the main
  427. window - it brings up the file requester and allows you to select modules.
  428. However, it doesn't cause the previous program to be cleared when you
  429. finish, and it doesn't start playing a new module immediately.  If you
  430. select a directory without selecting a filename, MultiPlayer will scan that
  431. directory and add all the files in it to the program.
  432.  
  433.  
  434. Del button
  435.  
  436.     This button deletes the currently selected module in the program list.
  437. If this module is currently playing, it doesn't stop the module immediately
  438. - the module continues playing until you select a different module.  The
  439. next module in the program will immediately become the currently selected
  440. module, so you can delete a range of modules by repeatedly clicking the Del
  441. button.
  442.  
  443.  
  444. Top, Up, Down, and Bot buttons
  445.  
  446.     These buttons allow you to rearrange the modules in the program.  They
  447. work on the currently selected module, and their meanings should be
  448. reasonably obvious.
  449.  
  450.  
  451. Load button
  452.  
  453.     Brings up the file requester so you can load a previously saved program
  454. from disk.  The newly loaded program will replace the current program.
  455.  
  456.     Note that you can also load saved programs from the regular module
  457. requester - programs are recognized just like modules, and programs
  458. selected this way will automatically be loaded and run.  (You could even
  459. put the name of another program file at the bottom of the first one, and
  460. chain programs together!)
  461.  
  462.  
  463. Save button
  464.  
  465.     Brings up the file requester and lets you save the current program to a
  466. disk file.  You can then load it again later through the Load gadget or
  467. using any method normally used to select modules - the file requester,
  468. Workbench extended-select when starting MultiPlayer, or CLI arguments.
  469. (See the 'Startup' for details on starting MultiPlayer.)
  470.  
  471.  
  472. Clear button
  473.  
  474.     Clears the entire current program list.  As with the 'Del' button, it
  475. does not stop any currently playing module.
  476.  
  477.  
  478. Sort button
  479.  
  480.     Sorts the entire current program list alphabetically.  Handy if you
  481. like to use random play (and thus don't really care about the play order)
  482. and you'd like a nice neat module listing.
  483.  
  484.  
  485. Program, Prefs, Settings, and Info buttons
  486.  
  487.     These buttons toggle on or off some of MultiPlayer's other
  488. commonly-used windows.  They can also be controlled with the functions keys
  489. F2-F5 (respectively).
  490.  
  491.  
  492.     If you want to create or modify saved program files yourself, just take
  493. a look at one of the files MultiPlayer generates - it's a simple text file.
  494. Lines starting with 'DIR' denote changes of directory - all filenames after
  495. that until another 'DIR' keyword will be looked for in that directory.
  496. Lines that start with a tab character (make sure they remain tab
  497. characters, and don't get converted to spaces!) contain the settings
  498. information for the module on the previous line.  I won't explain the
  499. format exactly, but it shouldn't be too hard for you to figure out if you
  500. want to.  (You can also look at the source code...)
  501.  
  502.  
  503.  
  504.                             Preferences Window
  505.                             ~~~~~~~~~~~~~~~~~~
  506.  
  507.     MultiPlayer's built-in Preferences window can be opened by clicking on
  508. the 'Prefs' button in the main or Program window, or by pressing F3 in any
  509. window.  It contains a few options which you can use to tailor MultiPlayer
  510. to your own preferences.  The gadgets are described below:
  511.  
  512.  
  513. Font buttons and displays
  514.  
  515.     These two buttons allow you to choose the font used for displaying the
  516. gadgets and other imagery used in MultiPlayer's windows.  Pressing either
  517. button brings up a standard ASL font requester (which is asynchronous, of
  518. course - it doesn't freeze up MultiPlayer while it's displayed).  The text
  519. and number gadgets beside each button show the currently selected font.
  520.  
  521.     The Main font is the font used to display almost all of MultiPlayer's
  522. gadgetry: essentially everything except the ListView gadgets in the Program
  523. window and the Information window.  For those, the List font is used
  524. instead.  The Main font can be any font you like, but the List font must be
  525. a fixed-width font.  For the window title bars, the screen's default is
  526. used.  (For the Workbench screen, this is selected by the System Text
  527. setting in the Font Preferences program.)
  528.  
  529.  
  530. Play gadget
  531.  
  532.     Use this gadget to tell MultiPlayer what to do when it gets to the end
  533. of one module.  When 'In sequence' is selected, entire program is played,
  534. in order, one module after another, and the sequence starts over at the
  535. beginning after the last module is played.  If you select 'Through sequence
  536. once', the entire sequence is played only once, then the player stops. In
  537. random play, a module plays once and then another is randomly selected. In
  538. 'once' mode, the song is played only once, then is ejected and MultiPlayer
  539. becomes idle.  In 'over and over' mode, anything you select is played
  540. forever until you tell MultiPlayer to start a different module.  (In these
  541. last two modes, you can still use the 'Next' and 'Prev' buttons in the main
  542. window to change modules; MultiPlayer just doesn't change by itself.)
  543.  
  544.  
  545. Show gadget
  546.  
  547.     This cycle gadget allows you to select the type of display you want to
  548. appear in the main window's title bar while a module is playing.  In Clock
  549. mode, a clock appears displaying the amount of time this module has been
  550. playing in minutes and seconds.  In Sequence mode (this has no relation to
  551. the 'in sequence' mode in the 'Play' gadget), on NoiseTracker or similar
  552. modules that play sequences of blocks, the current sequence number and the
  553. number of sequences in the song is displayed.  (On modules that don't
  554. support this, the clock is displayed instead.)  You can tell MultiPlayer to
  555. display the current sequence number either starting from 0 and ending at
  556. length-1, as most tracker programs display sequence numbers, or starting
  557. from 1 and ending at (length), which is the more 'natural' way of counting.
  558. Selecting the 'Nothing' option in this gadget will leave you with a clean,
  559. simple, unadulterated title bar.
  560.  
  561.  
  562. Hot key string gadget
  563.  
  564.     By default, this string gadget is empty and MultiPlayer behaves like a
  565. normal application.  However, you can enter a Commodities-style hotkey name
  566. into this gadget.  (Make sure you press Return in the gadget after changing
  567. the string!)  MultiPlayer will then activate that key as a hot key which
  568. you can use to open the main MultiPlayer control panel at any time.  When a
  569. hot key is active, clicking the control panel's close gadget closes all of
  570. MultiPlayer's windows, but does not terminate MultiPlayer or stop playing
  571. music.  You can use this too keep MultiPlayer hidden in the background,
  572. without using any screen space at all.
  573.  
  574.  
  575. Spectrogram, Note Scroller, StereoScope, and QuadraScope checkboxes
  576.  
  577.     Use these gadgets to toggle MultiPlayer's various "flashy windows" on
  578. and off.  These windows are described in detail later.  They can also be
  579. toggled with the F6-F9 keys (respectively).
  580.  
  581.  
  582. Fade... checkbox
  583.  
  584.     If this checkbox is activated, whenever you press the 'Play' or 'Stop'
  585. gadgets in the main control panel (or press the spacebar), the music
  586. gradually fades in and out rather than abruptly starting or stopping.
  587. This will only happen on modules that support volume control.
  588.  
  589.  
  590. Continue... checkbox
  591.  
  592.     If this is selected, if MultiPlayer encounters an error while trying to
  593. load or play a module in the program, instead of simply stopping dead, it
  594. moves on to the next program in the list, as requested with the Play gadget.
  595.  
  596.  
  597. Keep... checkbox
  598.  
  599.     If this checkbox is activated, MultiPlayer does two things differently
  600. than it normally does.  First, when you save the preferences, not only are
  601. the preferences saved as usual, but the currently loaded program is also
  602. saved in ENV: and ENVARC: in a file called "MultiPlayerProgram".  (It saves
  603. identical files into both directories.)  Second, when MultiPlayer starts
  604. up, if it sees that you have this option set, and you haven't specified any
  605. other modules or programs in the startup options, it automatically loads
  606. this program, without starting it.  This way, if you generally only keep
  607. one program around, this option provides an easy way to always load it
  608. automatically without worrying about any startup options or anything.  Even
  609. if you have this option selected, you can still load and save other
  610. programs normally through the Program window.
  611.  
  612.  
  613. AppIcon checkboxes
  614.  
  615.     If one of these is activated, MultiPlayer puts an icon on the Workbench
  616. screen which you can drop modules and directories into.  Dropping modules
  617. onto the 'Play' icon erases the old program and starts playing the new
  618. modules immediately.  Dropping modules onto the 'Add' icon simply adds the
  619. new files to the end of the current program, without affecting any module
  620. currently playing.  These icons will remain on the Workbench even if all of
  621. MultiPlayer's windows are closed, or if MultiPlayer's windows are on a
  622. different screen.  Double-clicking on the icon itself will pop up
  623. MultiPlayer.
  624.  
  625.     This feature works only if MultiPlayer can find its own icon on
  626. startup.  You can ensure this by starting MultiPlayer from the Workbench,
  627. or by naming the executable "Player" and having it in the current directory
  628. when you run MultiPlayer from the CLI.
  629.  
  630.  
  631. Save button
  632.  
  633.     Saves the current preferences to the disk file ENV:MultiPlayerPrefs, as
  634. well as to the same file in ENVARC:.  (With a preferences window as simple
  635. as this, I see no real need for separate 'Save' and 'Save Default'
  636. options.)  If the "Keep..." option is enabled, the current program will
  637. also be saved to both ENV: and ENVARC:, as MultiPlayerProgram.
  638.  
  639.     The preferences saved include, as well as the current settings of the
  640. above two gadgets, the positions of all the MultiPlayer windows, including
  641. the file and font requesters.  The next time you run MultiPlayer, the
  642. windows will pop up wherever they were when you saved the preferences. (If
  643. you open an ASL file or font requester and change its size or position, you
  644. must close it before saving the preferences, if you want its new position
  645. and size to be saved.  Nag Commodore about this misfeature, which stems
  646. from a lack of asynchronous functionality in the asl.library.)
  647.  
  648.  
  649. Close button
  650.  
  651.     Does exactly the same thing as the close gadget on the window does -
  652. closes the Preferences window.  It does NOT cause the new preferences to be
  653. activated, as you might expect, because they are already activated:
  654. anything you select gets activated the moment you select it.  (None of
  655. those exclusive Macie dialog boxes, please.)  There is no 'Cancel' gadget
  656. because I figure it's not too difficult to change back any buttons you
  657. accidentally hit.
  658.  
  659.  
  660.  
  661.                               Settings Window
  662.                               ~~~~~~~~~~~~~~~
  663.  
  664.     MultiPlayer's Settings window serves a function very similar to the
  665. Preferences window.  However, there is an important difference.  Instead of
  666. storing settings that apply to MultiPlayer as a whole, it is used to select
  667. options that pertain to individual modules in the program list.  To get it,
  668. click the 'Settings' button in the program window, or press F4 in any of
  669. MultiPlayer's windows.
  670.  
  671.     The Settings window contains a number of gadgets which control how the
  672. currently selected module (not necessarily the currently playing module) is
  673. to be played.  MultiPlayer stores separate settings for each module on the
  674. program list.  When you save the program, the settings for each module are
  675. saved with it.  Not all of the settings are applicable to every type of
  676. module, so some settings gadgets will be disabled for certain modules.
  677.  
  678.  
  679. Module box
  680.  
  681.     This text box displays the name of the currently selected module (the
  682. same as the name displayed under the program list gadget in the Program
  683. window).  This is not necessarily the module that is currently playing -
  684. you can edit the settings for one module while you play another (or while
  685. you're not playing any module).
  686.  
  687.  
  688. Volume, Balance, and Speed gadgets
  689.  
  690.     The gadgets in these two rows complement the corresponding gadgets in
  691. the control panel.  While the controls in the main window control whatever
  692. module is currently playing, these gadgets control the individual modules
  693. in the program.  For example, when you play a given module, the volume at
  694. which it plays is determined by both the master volume setting on the main
  695. control panel, and the volume setting for that specific module defined in
  696. the Settings window.  This allows you to set specific settings for
  697. individual modules, while still being able to control the overall speed,
  698. volume, and balance independently from the main control panel.
  699.  
  700. Note that the Speed gadget in this window works somewhat differently from
  701. the one in the main window.  The main window's Speed gadget is meant to be
  702. basically just for fast-forwarding through a song, while the Speed gadget
  703. in this window allows you to tell MultiPlayer how fast to play this module
  704. normally.  This window also contains two extra buttons, 'PAL' and 'NTSC',
  705. which set the Speed gadget to one of two common playing speeds.
  706.  
  707.  
  708. End box and gadgets
  709.  
  710.     These settings allow you to tell MultiPlayer when to stop a module that
  711. normally doesn't stop by itself, or to make MultiPlayer stop playing the
  712. module before it would normally end.  The text box displays the amount of
  713. time MultiPlayer will let the module play before stopping it, if you've set
  714. an endpoint.
  715.  
  716.     To set a module's endpoint, you must be currently playing the module
  717. you want to change the setting for.  (The Set button will only be activated
  718. if this is the case.)  When the music gets to the point where you would
  719. like it to stop every time you play it, click the Set button.  MultiPlayer
  720. will record the endpoint and, since setting the endpoint implies that you
  721. have reached it, the module will immediately end.  Next time you play that
  722. module, it will stop automatically at that point.  To clear a module's
  723. endpoint, just click the Clear button.
  724.  
  725.  
  726. Filter gadget
  727.  
  728.     This gadget determines how the low-pass filter (and the power LED) is
  729. handled.  Normally it's just set to 'controlled by module', so music
  730. modules can turn it on or off as part of their effects.  However, if a
  731. particular module does things you don't like with the filter, you can force
  732. the filter permanently on or off with this gadget, so the module can no
  733. longer control it.  Of course, this feature works only on module types that
  734. allow MultiPlayer to control the filter.
  735.  
  736.  
  737. Protracker tempo commands
  738.  
  739.     This checkbox is only activated for standard ST/NT/PT modules.  If it
  740. is not set, the Protracker player interprets all speed commands in the
  741. module as NoiseTracker and other older trackers did, and keeps the baseline
  742. frequency at 50Hz (or whatever you set the speed to).  If this checkbox is
  743. set (the default), the newer Protracker tempo commands are enabled.
  744.  
  745.     Basically, this option is here because there is no reliable way to
  746. detect whether a module is using only NoiseTracker speed commands or needs
  747. Protracker tempo commands.  While most modules will work fine on either
  748. setting, some will only play at the correct speed at one setting.  If you
  749. play a module and it suddenly starts going way too slow, or way too fast,
  750. or otherwise plays at an obviously "wrong" speed, try flipping this
  751. checkbox and start the module again.  In general, older modules need this
  752. checkbox to be off, while newer Protracker modules need it on.
  753.  
  754.  
  755. Fade checkbox
  756.  
  757.     If you select this checkbox, and the module supports volume control,
  758. then when the module ends, instead of stopping immediately it will continue
  759. for a couple seconds longer (most likely repeating an earlier part of the
  760. song), gradually fading out.  This is nice for the many modules that just
  761. repeat over and over, and never really end.  With this feature you can make
  762. the "artificial" ending seem a little more natural.
  763.  
  764.  
  765. Current button
  766.  
  767.     Pressing this button will set the currently selected module to the same
  768. as the currently playing module.  Thus, if you are listening to a module
  769. and decide you want to change something about it, you don't have to hunt it
  770. down in the program list - just press this button, and you can immediately
  771. make settings changes to the module you're listening to.
  772.  
  773.  
  774. Close button
  775.  
  776.     This button simply closes the Settings window.  Like the Close button
  777. in the Preferences window, it doesn't actually cause anything else to
  778. happen, because whenever you change anything in the Settings window, the
  779. changes take effect immediately.
  780.  
  781.  
  782.  
  783.                             Information Window
  784.                             ~~~~~~~~~~~~~~~~~~
  785.  
  786.     The Module Information window contains a single read-only ListView
  787. display which contains various miscellaneous information that MultiPlayer
  788. gleans out of the currently playing module.  For module types such as MED
  789. and GMOD which have specific support for some kind of general text string,
  790. that gets displayed here.  For ST/NT/PT modules, this contains the names of
  791. all the instruments (which composers often replace with messages, credits,
  792. and greetings).  The information window can be toggled on or off with
  793. either the Info button on the Program window, or with the F5 key.
  794.  
  795.     If the last instrument used in an ST/NT/PT module contains ASCII text
  796. instead of normal instrument data, it will be displayed here also.  It can
  797. be as long as desired, may contain newline characters, and MultiPlayer will
  798. automatically word-wrap long lines.  (Just for you Maruku...)
  799.  
  800.  
  801.  
  802.                               Flashy Windows
  803.                               ~~~~~~~~~~~~~~
  804.  
  805.     For your viewing pleasure, MultiPlayer contains some little gizmos that
  806. you've probably seen before in Eurodemos and other players.
  807.  
  808.     The Spectrogram window displays a bar graph of the frequencies
  809. currently playing.
  810.  
  811.     The Note Scroller window shows a miniature tracker-like display of the
  812. notes scrolling up the screen.  (You can't read the notes, but if you're
  813. using MultiPlayer you're probably wanting to listen to music, not read it,
  814. right?)  This works only on Protracker-type modules.
  815.  
  816.     The StereoScope window shows an oscilliscope-like view of the sound
  817. coming out of each channel.  The QuadraScope is basically the same thing as
  818. the StereoScope, except it has a separate display for each of the four
  819. channels. (You can have both the StereoScope and the QuardraScope active at
  820. the same time if you want.)
  821.  
  822.     All four windows can be toggled on and off from the Preferences window.
  823. Each also has a function key that works from any of the windows. You can
  824. toggle the Spectrogram window with F6, the Note Scroller with F7, the
  825. StereoScope with F8, and the QuadraScope with F9.
  826.  
  827.     All "flashy" window updating is done in a separate task with a priority
  828. of -5, so turning on these windows should not degrade system performance at
  829. all.  However, this means that the windows will stop updating temporarily
  830. when the system is heavily loaded.
  831.  
  832.  
  833.  
  834.                             Keyboard Shortcuts
  835.                             ~~~~~~~~~~~~~~~~~~
  836.  
  837.     Several keyboard shortcuts are available from any MultiPlayer window
  838. (except the file requester).  Most of these have been mentioned before in
  839. this document, but they are listed all together here as well.  These keys
  840. are listed below:
  841.  
  842. ESC key
  843.  
  844.     Terminates MultiPlayer immediately (a shortcut for the close gadget on
  845. the main window.
  846.  
  847. F1
  848.  
  849.     Opens and closes (or, rather, zooms and unzooms) the main control
  850. panel.  Same as the middle mouse button or the zoom gadget on 2.0.
  851.  
  852. F2 key
  853.  
  854.     Toggles the Program window (opens it, or closes it if it was already open).
  855.  
  856. F3 key
  857.  
  858.     Toggles the Preferences window.
  859.  
  860. F4 key
  861.  
  862.     Toggles the Settings window.
  863.  
  864. F5 key
  865.  
  866.     Toggles the Module Information window.
  867.  
  868. F6 key
  869.  
  870.     Toggles the Spectrogram window.  (Also toggles the Spectogram item in
  871. the Preferences window.)
  872.  
  873. F7 key
  874.  
  875.     Toggles the Note Scroller window.
  876.  
  877. F8 key
  878.  
  879.     Toggles the StereoScope window.
  880.  
  881. F9 key
  882.  
  883.     Toggles the Note Scroller window.
  884.  
  885. Spacebar
  886.  
  887.     If a module is currently playing, stops (or pauses) it without
  888. unloading it, just like the 'Stop' button in the main window.  If a module
  889. is loaded but NOT playing, it continues or restarts it, just like the
  890. 'Play' button.
  891.  
  892. Delete key
  893.  
  894.     Unloads ('ejects') the currently loaded module.
  895.  
  896. Up/down arrows
  897.  
  898.     These switch to the previous or next modules in the program list,
  899. respectively.  In random play, these simply select another module at
  900. random.  (These are shortcuts for the 'Next' and 'Prev' buttons in the main
  901. window.)
  902.  
  903. Left/right arrows
  904.  
  905.     For modules that contain more than one song, these select the previous
  906. or next song, respectively (shortcuts for the 'Song' cycle gadget).
  907.  
  908.  
  909.  
  910.                               Startup Options
  911.                               ~~~~~~~~~~~~~~~
  912.  
  913.     When starting MultiPlayer from Workbench, you can extended-select the
  914. icons of as many modules as you want when you start MultiPlayer.  It will
  915. add all of these modules to the program and immediately start playing the
  916. first one (or a random selection, if you have selected random play in your
  917. saved preferences).  Additionally, you may set certain default parameters
  918. in the ToolTypes field of MultiPlayer's Workbench icon; these are described
  919. later in this section.
  920.  
  921.     MultiPlayer supports a full set of 2.0-style command-line options.  You
  922. can get a brief list of them by typing 'Player ?' on the command line.  To
  923. get a brief description of the parameters, enter another question mark
  924. ('?') and press return at the prompt.
  925.  
  926.     Following is a description of these command-line arguments:
  927.  
  928.  
  929. DIR (synonym: DIRECTORY)
  930.  
  931.     The first argument on the command line (or the argument preceded by
  932. the DIR keyword, if you use the keyword) tells MultiPlayer what directory
  933. to go to the first time it displays the file requester.  This is also where
  934. it will look for modules you specify on the command line (see below) if you
  935. don't specify full pathnames for them.  Using this option to specify the
  936. directory where everything else comes from can save you some typing if you
  937. specify several modules that reside in the same directory on the command
  938. line.
  939.  
  940.  
  941. PLAY/M (synonym: MODULES/M)
  942.  
  943.     The second argument (if you don't explicitly use the DIRECTORY or
  944. PLAY/MODULES keywords) begins a list of modules to put into MultiPlayer's
  945. program list on startup and start playing immediately.  MultiPlayer imposes
  946. no limitations on the number of modules you can specify using this keyword,
  947. although AmigaDOS command lines are currently limited to 256 characters.
  948. After MultiPlayer starts up, instead of showing the file requester
  949. immediately, it will load and begin playing the first module in the program
  950. list (or a randomly selected module, if you have selected random playing in
  951. your saved Preferences).  Program list files act the same way as modules,
  952. so you can specify a program file to load and start initially instead of a
  953. list of modules.
  954.  
  955.  
  956. PROG/K (synonym: PROGRAM/K)
  957.  
  958.     You can use this keyword followed by the name of a program file as an
  959. alternative to the PLAY option.  If you use this option, MultiPlayer will
  960. load the named program file on startup and just go idle, rather than
  961. starting the first module immediately as it would if you used the PLAY
  962. keyword.  To start the program, just hit the "Next" or "Prev" gadgets in
  963. the main window (or just hit the up or down arrow keys in any of the
  964. MultiPlayer windows).
  965.  
  966.     Note that, apparently due to a bug in 2.04, if you specify the PROG
  967. keyword without giving a directory name as the first option, the PROG
  968. keyword and the program get put together and interpreted as a module name
  969. for the MODULE keyword!  Therefore, instead of "Player prog mus:blah", just
  970. use "Player mus: prog blah".
  971.  
  972.  
  973. SCREEN/K
  974.  
  975.     You can use this parameter to tell MultiPlayer to open its windows on a
  976. screen other than the Workbench (or default) screen.  Just supply the name
  977. of the public screen as this parameter, and MultiPlayer will try to use it
  978. for all its windows.  The named public screen must already be open.
  979.  
  980.  
  981. NOREQUEST/S
  982.  
  983.     If you specify the switch, MultiPlayer will not display the file
  984. requester immediately after it loads, even if you don't specify any modules
  985. to start playing.  If you don't specify any modules, MultiPlayer will
  986. simply sit idle until you tell it to do something.
  987.  
  988.  
  989. NOWINDOW/S
  990.  
  991.     This switch causes MultiPlayer to load and run without opening its main
  992. window.  If you specify modules to start playing, MultiPlayer will play
  993. them as usual, but you won't see any visual indication that MultiPlayer is
  994. running.  If you have activated a hot key in MultiPlayer's saved
  995. preferences, you can later open the control panel with it.  You can also
  996. open the window through MultiPlayer's ARexx port, assuming you haven't
  997. turned that off as well.
  998.  
  999.  
  1000. NOREXX/S
  1001.  
  1002.     If you specify this switch, MultiPlayer will not open its ARexx port.
  1003. I don't know what you'd really need this option for, but it's there...
  1004.  
  1005.  
  1006. NODETACH/S
  1007.  
  1008.     If you specify this switch, MultiPlayer will not automatically detach
  1009. itself from the CLI process.  In this case, unless you RUN it, it will keep
  1010. your CLI window until you quit MultiPlayer.
  1011.  
  1012.  
  1013.     If you run MultiPlayer from the Workbench, it will search through the
  1014. ToolTypes array in its own icon for parameters which are roughly equivalent
  1015. to the CLI parameters described above.
  1016.  
  1017. DIR (synonym: DIRECTORY)
  1018. PROG (synonym: PROGRAM)
  1019. SCREEN
  1020.  
  1021.     These ToolTypes act exactly like the corresponding CLI arguments.
  1022. Simply enter one of these ToolType labels, then an equals ('=') sign, then
  1023. the appropriate text.  For example, to load the program "Mus:DefaultProg"
  1024. on startup, add the ToolType "PROG=Mus:DefaultProg".
  1025.  
  1026. REQUEST
  1027. WINDOW
  1028. REXX
  1029.  
  1030.     These ToolTypes perform the same functions as the similarly named CLI
  1031. arguments, but instead of simply being flags,they are YES/NO ToolTypes. For
  1032. example, to prevent MultiPlayer from opening the main window on startup,
  1033. enter "WINDOW=NO" into the ToolTypes.
  1034.  
  1035.  
  1036.  
  1037.                                 ARexx Port
  1038.                                 ~~~~~~~~~~
  1039.  
  1040.     Whenever MultiPlayer is running, there is an ARexx port available
  1041. called "RXTRACKER" which you can send various commands to.  MultiPlayer's
  1042. ARexx port is designed to be (mostly) compatible with the program RxTracker
  1043. by Dominic Giampaolo.  In addition, it has several extended features, and
  1044. of course you can use it to play all the different kinds of modules
  1045. MultiPlayer understands.
  1046.  
  1047.     If MultiPlayer runs into an error when trying to load or play a module,
  1048. it generally returns an error code of 10 to the ARexx program.  When any
  1049. error occurs, a descriptive error string is saved and you can get it with
  1050. the LASTERROR command.
  1051.  
  1052.     A listing of the ARexx commands MultiPlayer understands follows:
  1053.  
  1054.  
  1055. LOAD    <filename>
  1056.  
  1057.     Loads a module into memory from disk.  It is generally a good idea to
  1058. supply a complete pathname, since MultiPlayer looks for the module starting
  1059. at whatever directory the file requester last happened to be looking at.
  1060. This command does not start the module playing.  If you want to start
  1061. playing immediately, you don't have to use this command at all - you can
  1062. simply supply a filename on the PLAY command and it will load and start
  1063. playing immediately.  Note that unless you tell MultiPlayer to load a
  1064. program file, this command won't affect the program list at all - the ARexx
  1065. port in general operates independently of the standard user interface.  If
  1066. you explicitly tell MultiPlayer to load a program file using this command,
  1067. then the new program list will replace the old one.
  1068.  
  1069.  
  1070. PLAY    [<filename>] [<songnumber>]
  1071.  
  1072.     Starts playing a module.  If you supply the filename, MultiPlayer stops
  1073. any module currently playing and tries to load the specified module from
  1074. disk, like the LOAD command.  If you don't supply the filename, MultiPlayer
  1075. plays (or re-plays from the start) an already-loaded module.  (If no module
  1076. is loaded and you don't specify a filename, MultiPlayer returns error code
  1077. 5 and otherwise does nothing.)  For modules with more than one song, you
  1078. can supply the song number to play.  Songs are numbered starting at zero.
  1079. If you don't supply a song number, the first one (song zero) is assumed.
  1080.  
  1081.  
  1082. STOP
  1083.  
  1084.     Stops playing any module that is currently playing without unloading
  1085. the module.  You can then restart it later with PLAY or CONTINUE.
  1086.  
  1087.  
  1088. UNLOAD
  1089.  
  1090.     Stops and unloads any currently loaded module.
  1091.  
  1092.  
  1093. CONTINUE
  1094.  
  1095.     Tries to restart a stopped module at the position it was at before the
  1096. STOP command was given.  If the module has never been started, it simply
  1097. starts from the beginning.  If the module was already playing, it does
  1098. nothing.  If the module type doesn't support restarting, MultiPlayer
  1099. returns error code 5 and does NOT start the module - you can then use PLAY
  1100. to start again from the beginning if you want, or else chew out the user
  1101. for playing weird module formats.
  1102.  
  1103.  
  1104. OPENWINDOWS
  1105.  
  1106.     Opens the main MultiPlayer window.  It will be opened in the small
  1107. title-bar zoom state, and none of MultiPlayer's other windows will be
  1108. opened with it.  If the window was already open, this command does nothing.
  1109. It returns an error if the window can't be opened.  Remember that while the
  1110. window is open the user can use it to change modules and such, possibly
  1111. messing up your perfectly organized and timed ARexx-controlled playing
  1112. sequences.
  1113.  
  1114.  
  1115. CLOSEWINDOWS
  1116.  
  1117.     Closes all MultiPlayer windows, if any were open.  MultiPlayer remains
  1118. active, and continues playing any modules it was already playing.
  1119.  
  1120.  
  1121. LASTERROR
  1122.  
  1123.     Returns an error message describing the last error that occurred that
  1124. had to do with the ARexx port.  (Errors that the user causes by
  1125. manipulating the window do not affect this.) You'll have to have 'options
  1126. results' turned on for this to work, and the error will appear in the
  1127. 'RESULT' variable.
  1128.  
  1129.  
  1130. QUIT
  1131.  
  1132.     Causes MultiPlayer to terminate immediately.
  1133.  
  1134.  
  1135.  
  1136.                                  Messages
  1137.                                  ~~~~~~~~
  1138.  
  1139.     This section lists most of the error or warning messages MultiPlayer
  1140. can produce.  Look here if you have trouble deciphering the meaning of one.
  1141.  
  1142.  
  1143. "Not enough chip memory"
  1144.  
  1145.     Tracker-style modules generally must be loaded into one big continuous
  1146. chunk of chip memory.  Therefore, even if the Workbench (or some other
  1147. program) says you have enough memory, it may not have one big enough chunk.
  1148. Close some windows, exit some programs.  If all else fails, reboot and try
  1149. fresh.
  1150.  
  1151.  
  1152. "Not enough memory"
  1153.  
  1154.     You really are getting low.  MultiPlayer doesn't normally need too much
  1155. non-chip memory, since modules are always loaded into chip memory.  If you
  1156. get this message, it means you don't have much memory of ANY kind
  1157. available.  Better free up something quick.
  1158.  
  1159.  
  1160. "Required memory occupied"
  1161.  
  1162.     You will only get this message from non-relocatable AMOD or GMOD
  1163. modules.  It means that the module has a specific address it must be loaded
  1164. into, but part or all of the required block of memory is already in use.
  1165. Free up as much memory as possible and try again.  If most of your memory
  1166. is free and you still can't load it, chances are there's some little
  1167. allocated fragment that some program has forgotten about that's still
  1168. sitting in the required area.  Your best bet is to reboot and try on a
  1169. fresh system.  If you have more than 512K of chip memory, try running my
  1170. program 'ChipMunch' (included with the official distribution of
  1171. MultiPlayer) just after you reboot to keep programs out of the commonly
  1172. used areas.
  1173.  
  1174.  
  1175. "Unknown module type"
  1176.  
  1177.     MultiPlayer doesn't recognize the file you selected as one of the
  1178. module types it knows.  Either this isn't a music module, or it's one that
  1179. it doesn't know how to handle.  If it is a music module that MultiPlayer
  1180. doesn't know about, send me the module and player/interface code, and it
  1181. should make it into the next version of MultiPlayer.
  1182.  
  1183.  
  1184. "Corrupt module"
  1185.  
  1186.     MultiPlayer recognized the module, but it didn't look right for some
  1187. reason.  Maybe it's a module written with an incompatible version of the
  1188. music program, or maybe the module itself got munched somehow.
  1189.  
  1190.  
  1191. "Error playing module"
  1192.  
  1193.     A general catch-all.  This error usually is displayed as a result of
  1194. error reports from initialization routines of individual players.  It
  1195. generally means that the module loaded fine, but the player had trouble
  1196. playing it.  Sometimes it means the same thing as "Corrupt module", or it
  1197. might mean that the player ran out of memory but was too stupid to tell
  1198. MultiPlayer about it specifically.
  1199.  
  1200.  
  1201. "Can't load module"
  1202.  
  1203.     The requested file was not found, or there was a disk error while
  1204. reading it.  If you get this message after selecting a file from the file
  1205. requester, chances are the disk is corrupt (in this case AmigaDOS should
  1206. have already given you a requester saying so), or the file may be open for
  1207. writing from some other program.
  1208.  
  1209.  
  1210. "Directory not found"
  1211.  
  1212.     Somehow you managed to tell MultiPlayer to load something from a
  1213. directory that doesn't exist.  Maybe you moved the directory somewhere
  1214. else, or forgot an Assign somewhere.  This usually only happens with ARexx
  1215. commands or loaded programs.
  1216.  
  1217.  
  1218. "Audio hardware in use"
  1219.  
  1220.     MultiPlayer can't allocate the audio hardware through the audio.device.
  1221. This probably means that some other music editor or player is currently
  1222. running.  Find the culprit program and close it.  If all else fails, reboot
  1223. and try again.
  1224.  
  1225.  
  1226. "No CIAB timers available"
  1227.  
  1228.     MultiPlayer generally uses one of the two timers on CIA (Complex
  1229. Interface Adapter) B for timing its music.  However, other programs like to
  1230. use these also.  In particular, (I believe) one of the timers may be in use
  1231. if the serial port is in operation.  Other than that, music programs are
  1232. generally the biggest consumers of CIAB timers.  Make sure no other music
  1233. player or composer programs are running, and try closing terminal programs
  1234. or other programs that use the serial port.
  1235.  
  1236.  
  1237. "Please decompress this module"
  1238.  
  1239.     It is unlikely that you will ever get this message, but if you do, it
  1240. means that (a) the module MultiPlayer is trying to load is compressed
  1241. somehow (MultiPlayer had to use the xpkmaster.library to decompress it),
  1242. and (b) it is an AMOD or GMOD module that must load at an absolute address,
  1243. and (c) MultiPlayer would have to re-load the module rather than just
  1244. copying it to its final position because the memory the module occupied
  1245. initally overlapped the required module address.  If you don't quite
  1246. follow, don't sweat - just decompress the module.
  1247.  
  1248.  
  1249. "Can't exit at this point"
  1250.  
  1251.     You tried to exit MultiPlayer while an ASL file or font requester was
  1252. open.  The asl.library file requesters currently don't provide any friendly
  1253. way for the client (MultiPlayer in this case) to close the file requester
  1254. before the user clicks on one of the gadgets or the close box.  Thus,
  1255. MultiPlayer must refuse to exit until you close those file requesters
  1256. manually.
  1257.  
  1258.  
  1259.  
  1260.                              Supported Formats
  1261.                              ~~~~~~~~~~~~~~~~~
  1262.  
  1263. MultiPlayer currently supports the following module types:
  1264.  
  1265.         15-instrument SoundTracker modules (most anyway)
  1266.         31-instrument SoundTracker/NoiseTracker 1.3D modules
  1267.  
  1268.         Protracker 1.0-1.1B modules
  1269.  
  1270.         SoundTracker 2.6 modules
  1271.  
  1272.         NoiseTracker 1.3D packed modules (with or without the embedded player)
  1273.  
  1274.         StarTrekker 1.2 AM/FM modules (Extra '.NT' file required)
  1275.  
  1276.         MED 3.00-3.21 and OctaMED 1.00-1.00b modules
  1277.                 Modules (MMD0) only - not "Song&Samples" files.
  1278.                 (Thanks Mr. Kinnunen!)
  1279.  
  1280.         Oktalyzer 4- and 8-channel modules
  1281.                 Uses my own 8-channel play engine.  8-channel modules will
  1282.                 be slightly higher quality on a 68020+ processor.
  1283.  
  1284.         SoundFX V1.3 executable modules (Player V2.2)
  1285.                 Will probably ONLY work with this version, since it does
  1286.                 some run-time patching to make it play under MultiPlayer.
  1287.  
  1288.         Future Composer 1.3 ('SMOD') and 1.4 ('FC14') modules
  1289.  
  1290.         JamCrackerPro 1.0a modules
  1291.  
  1292.         SoundMonitor 2.0 modules
  1293.  
  1294.         SidMon 2.1 modules
  1295.  
  1296.         Delta Music modules (two versions)
  1297.  
  1298.         Mark II modules
  1299.  
  1300.         Dave Whittaker modules
  1301.  
  1302.         Face The Music modules (DO NOT COMPRESS!)
  1303.                 This is very kludgy at best - you must have "PlayFTM:" ASSIGNed
  1304.                 to the PlayFTM program file.  (Didn't know you could ASSIGN
  1305.                 to a file?  Now you do!)  The procedure involves loading the
  1306.                 module, the external player, and then the module again.  Ack!
  1307.                 Apologies to floppy users.  I'm trying to contact the author(s)
  1308.                 of FTM to get some real player code, but no luck so far.
  1309.  
  1310.         Generic embedded-player modules that start with something like
  1311.                         jmp init(pc)
  1312.                         jmp music(pc)
  1313.                         jmp end(pc)
  1314.                 (Such as NoiseTracker 1.3 packed w/player modules)
  1315.  
  1316.         AudioMaster III sequenced 8SVX sounds (mono only)
  1317.  
  1318.         'XMOD', 'AMOD', and 'GMOD' formats described in 'Formats.doc'
  1319.  
  1320.  
  1321.     Although sequenced 8SVX sounds are technically only sampled sound
  1322. files, they have some music capability and look promising.  Besides, the
  1323. player also plays non-sequenced 8SVX sounds, so you can also play your
  1324. movie clips and such with MultiPlayer.  (I'm not sure if AudioMaster III is
  1325. the only program that currently supports sequenced 8SVX files, but it's the
  1326. only one I've seen so far.) Stereo is currently not supported - sorry, I'll
  1327. get to that eventually.
  1328.  
  1329.  
  1330.  
  1331.                               Version History
  1332.                               ~~~~~~~~~~~~~~~
  1333.  
  1334. 1.30    (R3, 25-May-92)
  1335.         GNU-ized and released with full source code.
  1336.  
  1337. 1.21    (R2, unreleased)
  1338.         Icon 8-colorized.  (Thanks Barry McConnell!)
  1339.         The "Protracker tempo commands" option is now on by default.
  1340.         Protracker player now uses the audio.device NotePlayer, so all Protracker
  1341.             playing is now completely system-friendly.
  1342.         Some windows rearranged significantly.
  1343.         Other minor bug fixes and enhancements.
  1344.  
  1345. 1.20    (R1, 5-May-92)
  1346.         Finally got around to bumping the minor revision counter. :-)
  1347.         This version does NOT work under 1.3 or earlier versions of Kickstart.
  1348.         Added SoundTracker 2.6 support.
  1349.         Added NODETACH command-line switch.
  1350.         Added command-line extended help (displayed if you type "MultiPlayer ?"
  1351.             and then enter "?" again at the template prompt).
  1352.         Module and Program file requesters now remember their current paths separately.
  1353.             (Side effect: it is now possible to show both file requesters at once!)
  1354.         File and font requester positions and sizes are now saved in
  1355.             MultiPlayer's preferences.
  1356.         Rearranged the function keys yet again.  (THIS time it _should_ be for good...)
  1357.         Added Module Information window.
  1358.             (Displays instruments, scolltexts, even MaruSampleTexts...)
  1359.         Redrew MultiPlayer's icon.  (About time...)
  1360.         Added AppIcon support.  (You can drop modules into it even when MultiPlayer's
  1361.             windows are closed or on another screen.)
  1362.         Changed speed control range on the main panel to be more useful.
  1363.             (The normal position is to the far left, and it can go VERY fast.)
  1364.         Added sequence jump controls to the main panel.
  1365.         Added balance reset gadgets in the main and settings windows.
  1366.         Added support for user-selectable fonts in the windows.
  1367.         Added "continue program on error" preferences option.
  1368.         Added "Through sequence once" option in Play mode in Preferences.
  1369.  
  1370. 1.17    (28-Feb-92)
  1371.         Fixed a serious bug in Guido (the user interface system) that sometimes
  1372.             caused crashes under 2.0.
  1373.         Fixed a tempo bug in the Protracker player.
  1374.         Modules in the program list are now played by double-clicking them.
  1375.             (lets you delete and do other things on them without playing them.)
  1376.         Added Settings window.  (Get to it from the Program window.)
  1377.         Rearranged the function key assignments yet again.
  1378.             (Sorry - they should stay the same for a while now.)
  1379.         MultiPlayer can now read parameters from its ToolTypes for options when
  1380.             started from Workbench.
  1381.         Added volume control to Oktalyzer 8-channel player.
  1382.         Added Commodities support under 2.0 - only one copy of MultiPlayer
  1383.             gets run at once, and you can pop it up with a hot key.
  1384.         Two of the ARexx port's command names have changed: OPENWINDOW and CLOSEWINDOW
  1385.             are now OPENWINDOWS and CLOSEWINDOWS.
  1386.         Added "Keep program with preferences" option (in the Preferences window).
  1387.         Changed the random number generator, hopefully for the better.
  1388.         Note: The 1.3 support in this version of MultiPlayer is very minimal.  The
  1389.             next version will probably not support 1.3 at all.  Going, going...
  1390.  
  1391. 1.16    (8-Feb-92)
  1392.         Fixed a serious bug in the DeltaMusic player.
  1393.         Save Prefs now snapshots both states of main window.
  1394.         Flashy window updates now run in a separate low-priority task.
  1395.         Upgraded MED 3.20 player to 3.21, and added Continue support.
  1396.             (Thanks Mr. Kinnunen!)
  1397.         Added (very kludgy) Face The Music support.
  1398.             (See the "Supported Formats" section for how to use it.)
  1399.         Added PROG keyword to command line options.
  1400.             (Lets you load a program file without starting immediately.)
  1401.         Fixed Mark II player.
  1402.         Protracker player now supports CIA tempo commands.
  1403.         Created Quadrascope and Note Scroller windows.
  1404.         Right and middle mouse buttons now work in all windows.
  1405.         LED (and filter) no longer get turned on at inappropriate times.
  1406.         Added directory scanning feature to program list manager.
  1407.             (If you "add" a directory to the program, MultiPlayer scans
  1408.             it and adds its contents to the program.)
  1409.         Added volume, balance, and speed controls to main window.
  1410.  
  1411. 1.15    (17-Jan-92)
  1412.         Upgraded MED 3.11 player to MED 3.20.
  1413.             (The MED player also now supports multiple songs).
  1414.         Added OctaMED 1.00 support.
  1415.         Fixed a small bug in author search routine.
  1416.         Fixed SidMon player bug.
  1417.         Added Spectrogram and Scope windows.
  1418.         Created non-overlaid version (Player.nov) for registered release.
  1419.  
  1420. 1.14    (6-Jan-92)
  1421.         Internal pseudo-release.
  1422.  
  1423. 1.13    (1-Jan-92)
  1424.         Added Oktalyzer 8-channel support using my own 8-channel audio engine.
  1425.             (Never did find a real Oktalyzer 8-channel play routine.)
  1426.  
  1427. 1.12    (29-Dec-91)
  1428.         Protracker support added by replacing the NoiseTracker player with the
  1429.             (similarly modified) Protracker 1.1B player.  I haven't detected
  1430.             any backward incompatibilities with NoiseTracker modules, but
  1431.             tell me if you find any.
  1432.         Oktalyzer 4-channel player finally tested and fixed.
  1433.                 (Yep, it didn't work at all.  Sorry...)
  1434.  
  1435. 1.11b   (19-Dec-91)
  1436.         Control panel clock/sequence display now always matches title color under 2.0.
  1437.         Fixed minor event-handling bug.
  1438.  
  1439. 1.11a   (12-Dec-91)
  1440.         Fixed bug in 8SVX player.
  1441.         Window positions are now saved with preferences.
  1442.  
  1443. 1.11    (10-Dec-91)
  1444.         Repeat detection bug in ST/NT player fixed.
  1445.         Program and preferences windows now save their positions while closed.
  1446.         Enhanced author name detection.
  1447.         Added middle-mouse-button zoom feature.
  1448.         Added 'Nothing' option to the show mode in preferences.
  1449.         Improved Delta Music module recognition.
  1450.  
  1451. 1.10    (18-Nov-91)
  1452.         Right mouse button in the main window has changed functions:
  1453.             Under 1.3, it zooms the window (since there's no zoom gadget)
  1454.             Under 2.0, it shows the program window (like the Help or F1 key)
  1455.         File requester is now asynchronous (other windows remain active).
  1456.         Control panels are now fully 1.3 compatible.
  1457.             (Although they still don't look as nice as in 2.0...)
  1458.         Keyboard shortcuts now supported in all control panels.
  1459.         Added public screen support.
  1460.         Added "play once" feature.
  1461.         DMA delays now use scanline waits instead of delay loops.
  1462.         Re-opening sub windows now closes them rather than bringing them to the front.
  1463.         Added AppWindow support for 2.0.
  1464.  
  1465. 1.01    (8-Nov-91)
  1466.         Added 'Sort' button in program window.
  1467.         Fixed a serious bug in GMOD player.  (Only serious if you have GMOD modules...)
  1468.         Enhanced author name recognition for ST/NT modules.
  1469.  
  1470. 1.00    (5-Nov-91)
  1471.         This is basically a rewrite of most of the program.
  1472.             (I'm not listing all the additions - there are way too many.)
  1473.         Major changes and additions to Formats.doc.
  1474.         Music no longer cuts off when file requester is displayed.
  1475.         Removed built-in code compression.  (Maybe I'll put it back in later.)
  1476.         Audio device now allocated while playing music.
  1477.         Fixed SoundFX player bug which caused crashing on advanced processors.
  1478.         Players now use longer DMA delays (normally 300) only on fast processors.
  1479.             (Wouldn't want to bog down you poor ol' 68000 users would we?)
  1480.         Major rewrite of player selection code.
  1481.         CIAB interrupts now defer to software interrupts to avoid hogging
  1482.             CPU time in a high-priority interrupt.
  1483.  
  1484. 0.95a   (6-Sep-91)
  1485.         Fixed bug where song position appeared when no module was playing.
  1486.         Fixed ST/NT player bug for modules with negative song repeat positions.
  1487.  
  1488. 0.95    (27-Jul-91)
  1489.         Added song position indicator for ST/NT and MED modules.
  1490.         Added code to turn low-pass filter off by default (will soon be selectable).
  1491.         Added Messages section to the documentation.
  1492.         Fixed window position so it snuggles right up next to the screen gadgets.
  1493.  
  1494. 0.94a   (26-Jul-91)
  1495.         Fixed player window height on pre-2.0 operating systems.
  1496.         Increased delay loop (ugh!) in NoiseTracker player for faster processors.
  1497.         Fixed song repeat bug in NoiseTracker player.
  1498.         Hacked NoiseTracker player to play old 15-instrument modules.
  1499.         Fixed memory trashing bug in NoiseTracker player.
  1500.             (I hate cleaning up someone else's code!)
  1501.  
  1502. 0.94    (23-Jul-91)
  1503.         Uses one of the CIAB timers for timing rather than the VBlank interrupt.
  1504.         Finally uses Workbench 2.0 ASL file requester if available.
  1505.         Added MED 3.xx modules, removed MED 2.xx songs.
  1506.  
  1507. 0.93    (3-Jul-91)
  1508.         Workbench 2.0 compatible (although some modules may not be).
  1509.  
  1510. 0.92    (7-Jun-91)
  1511.         Added 'AMOD' absolute loading module format described in 'Formats.doc'.
  1512.         Added 'GMOD' general module format described in 'Formats.doc'.
  1513.         Added NoiseTracker 1.3D packed (with player) modules.
  1514.         Added StarTrekker 1.2 AM synthesized modules.
  1515.         Updated the SoundTracker/NoiseTracker player.
  1516.             (New player comes from NoiseTracker 1.3D)
  1517.  
  1518. 0.91    (29-Apr-91)
  1519.         Added 'XMOD' format described in 'Formats.doc'.
  1520.         Removed "unknown" module formats (turned those modules into XMOD's)
  1521.  
  1522. 0.90    (27-Apr-91)
  1523.         First preliminary release.  Nothing fantastic.
  1524.  
  1525.  
  1526.  
  1527.                               Contact Address
  1528.                               ~~~~~~~~~~~~~~~
  1529.  
  1530.     I tend to move around a great deal, so mail sent directly to me
  1531. sometimes has a hard time catching up.  If you want mail to reach me (it
  1532. may take a while, but it WILL reach me), send it to this address:
  1533.  
  1534.         Bryan Ford
  1535.         8749 Alta Hills Circle
  1536.         Sandy, UT 84093
  1537.  
  1538.     I can be reached more quickly (for the time being anyway) on the phone
  1539. or through one of the electronic mail addresses below:
  1540.  
  1541.         (801) 585-4619
  1542.         bryan.ford@m.cc.utah.edu
  1543.         baf0863@cc.utah.edu
  1544.         baf0863@utahcca.bitnet
  1545.  
  1546.     If you want to get something to me through the mail more quickly, FIRST
  1547. call or E-mail me to make sure I'm still here, then send it to this
  1548. address:
  1549.  
  1550.         Bryan Ford
  1551.         27104 Ballif Hall
  1552.         University of Utah
  1553.         Salt Lake City, UT 84112
  1554.  
  1555.  
  1556.